﻿//-----------------------------------------------------------------------------------------
// <copyright file="WheelKey.cs" company="Jakub Florczyk (www.jakubflorczyk.pl)">
//      Copyright © 2009 Jakub Florczyk (www.jakubflorczyk.pl)
//      http://samsungmobilesdknet.codeplex.com
// </copyright>
//-----------------------------------------------------------------------------------------

namespace SamsungMobileSDKNET
{
    using System.Runtime.InteropServices;

    /// <summary>
    /// Samsung Wheel Key API.
    /// </summary>
    /// <remarks>
    /// The Samsung Wheel Key API enables applications to distinguish between normal Windows UP &amp; DOWN key events from that of wheel key UP &amp; DOWN events.
    /// </remarks>
    public class WheelKey
    {
        /// <summary>
        /// Checks whether the key message is from the wheel key.
        /// </summary>
        /// <param name="virtualKeyCode">Virtual-key code of the key message.</param>
        /// <param name="scanCode">Scan code of the key message.</param>
        /// <returns>
        /// TRUE if the message is from the wheel key 
        /// <br/>
        /// FALSE if the message is not from the wheel key 
        /// </returns>
        [DllImport(Common.DllName, EntryPoint = "SmiKeyMsgIsFromWheelKey")]
        public static extern bool KeyMsgIsFromWheelKey(
            [In] uint virtualKeyCode, 
            [In] uint scanCode);
    }
}
